3 * This program is free software; you can redistribute it and/or modify
4 * it under the terms of the GNU General Public License as published by
5 * the Free Software Foundation; either version 2 of the License, or
6 * (at your option) any later version.
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License along
14 * with this program; if not, write to the Free Software Foundation, Inc.,
15 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
16 * http://www.gnu.org/copyleft/gpl.html
20 * @author Alexandre Emsenhuber
21 * @author Daniel Friesen
25 use MediaWiki\Logger\LoggerFactory
;
26 use MediaWiki\MediaWikiServices
;
27 use Wikimedia\ScopedCallback
;
30 * Group all the pieces relevant to the context of a request into one instance
32 class RequestContext
implements IContextSource
, MutableContext
{
81 private static $instance = null;
84 * @param Config $config
86 public function setConfig( Config
$config ) {
87 $this->config
= $config;
93 public function getConfig() {
94 if ( $this->config
=== null ) {
95 // @todo In the future, we could move this to WebStart.php so
96 // the Config object is ready for when initialization happens
97 $this->config
= MediaWikiServices
::getInstance()->getMainConfig();
100 return $this->config
;
104 * @param WebRequest $request
106 public function setRequest( WebRequest
$request ) {
107 $this->request
= $request;
113 public function getRequest() {
114 if ( $this->request
=== null ) {
115 global $wgCommandLineMode;
116 // create the WebRequest object on the fly
117 if ( $wgCommandLineMode ) {
118 $this->request
= new FauxRequest( [] );
120 $this->request
= new WebRequest();
124 return $this->request
;
128 * @deprecated since 1.27 use a StatsdDataFactory from MediaWikiServices (preferably injected)
130 * @return IBufferingStatsdDataFactory
132 public function getStats() {
133 return MediaWikiServices
::getInstance()->getStatsdDataFactory();
139 public function getTiming() {
140 if ( $this->timing
=== null ) {
141 $this->timing
= new Timing( [
142 'logger' => LoggerFactory
::getInstance( 'Timing' )
145 return $this->timing
;
149 * @param Title|null $title
151 public function setTitle( Title
$title = null ) {
152 $this->title
= $title;
153 // Erase the WikiPage so a new one with the new title gets created.
154 $this->wikipage
= null;
160 public function getTitle() {
161 if ( $this->title
=== null ) {
162 global $wgTitle; # fallback to $wg till we can improve this
163 $this->title
= $wgTitle;
166 __METHOD__
. ' called by ' . wfGetAllCallers( 5 ) . ' with no title set.'
174 * Check, if a Title object is set
179 public function hasTitle() {
180 return $this->title
!== null;
184 * Check whether a WikiPage object can be get with getWikiPage().
185 * Callers should expect that an exception is thrown from getWikiPage()
186 * if this method returns false.
191 public function canUseWikiPage() {
192 if ( $this->wikipage
) {
193 // If there's a WikiPage object set, we can for sure get it
196 // Only pages with legitimate titles can have WikiPages.
197 // That usually means pages in non-virtual namespaces.
198 $title = $this->getTitle();
199 return $title ?
$title->canExist() : false;
204 * @param WikiPage $wikiPage
206 public function setWikiPage( WikiPage
$wikiPage ) {
207 $pageTitle = $wikiPage->getTitle();
208 if ( !$this->hasTitle() ||
!$pageTitle->equals( $this->getTitle() ) ) {
209 $this->setTitle( $pageTitle );
211 // Defer this to the end since setTitle sets it to null.
212 $this->wikipage
= $wikiPage;
216 * Get the WikiPage object.
217 * May throw an exception if there's no Title object set or the Title object
218 * belongs to a special namespace that doesn't have WikiPage, so use first
219 * canUseWikiPage() to check whether this method can be called safely.
222 * @throws MWException
225 public function getWikiPage() {
226 if ( $this->wikipage
=== null ) {
227 $title = $this->getTitle();
228 if ( $title === null ) {
229 throw new MWException( __METHOD__
. ' called without Title object set' );
231 $this->wikipage
= WikiPage
::factory( $title );
234 return $this->wikipage
;
238 * @param OutputPage $output
240 public function setOutput( OutputPage
$output ) {
241 $this->output
= $output;
247 public function getOutput() {
248 if ( $this->output
=== null ) {
249 $this->output
= new OutputPage( $this );
252 return $this->output
;
258 public function setUser( User
$user ) {
265 public function getUser() {
266 if ( $this->user
=== null ) {
267 $this->user
= User
::newFromSession( $this->getRequest() );
274 * Accepts a language code and ensures it's sane. Outputs a cleaned up language
275 * code and replaces with $wgLanguageCode if not sane.
276 * @param string $code Language code
279 public static function sanitizeLangCode( $code ) {
280 global $wgLanguageCode;
282 // BCP 47 - letter case MUST NOT carry meaning
283 $code = strtolower( $code );
286 if ( !$code ||
!Language
::isValidCode( $code ) ||
$code === 'qqq' ) {
287 $code = $wgLanguageCode;
294 * @param Language|string $language Language instance or language code
295 * @throws MWException
298 public function setLanguage( $language ) {
299 if ( $language instanceof Language
) {
300 $this->lang
= $language;
301 } elseif ( is_string( $language ) ) {
302 $language = self
::sanitizeLangCode( $language );
303 $obj = Language
::factory( $language );
306 throw new MWException( __METHOD__
. " was passed an invalid type of data." );
311 * Get the Language object.
312 * Initialization of user or request objects can depend on this.
317 public function getLanguage() {
318 if ( isset( $this->recursion
) ) {
319 trigger_error( "Recursion detected in " . __METHOD__
, E_USER_WARNING
);
321 wfDebugLog( 'recursion-guard', "Recursion detected:\n" . $e->getTraceAsString() );
323 $code = $this->getConfig()->get( 'LanguageCode' ) ?
: 'en';
324 $this->lang
= Language
::factory( $code );
325 } elseif ( $this->lang
=== null ) {
326 $this->recursion
= true;
329 $request = $this->getRequest();
330 $user = $this->getUser();
332 $code = $request->getVal( 'uselang', 'user' );
333 if ( $code === 'user' ) {
334 $code = $user->getOption( 'language' );
336 $code = self
::sanitizeLangCode( $code );
338 Hooks
::run( 'UserGetLanguageObject', [ $user, &$code, $this ] );
340 if ( $code === $this->getConfig()->get( 'LanguageCode' ) ) {
341 $this->lang
= MediaWikiServices
::getInstance()->getContentLanguage();
343 $obj = Language
::factory( $code );
347 unset( $this->recursion
);
349 catch ( Exception
$ex ) {
350 unset( $this->recursion
);
361 public function setSkin( Skin
$skin ) {
362 $this->skin
= clone $skin;
363 $this->skin
->setContext( $this );
369 public function getSkin() {
370 if ( $this->skin
=== null ) {
372 Hooks
::run( 'RequestContextCreateSkin', [ $this, &$skin ] );
373 $factory = SkinFactory
::getDefaultInstance();
375 // If the hook worked try to set a skin from it
376 if ( $skin instanceof Skin
) {
378 } elseif ( is_string( $skin ) ) {
379 // Normalize the key, just in case the hook did something weird.
380 $normalized = Skin
::normalizeKey( $skin );
381 $this->skin
= $factory->makeSkin( $normalized );
384 // If this is still null (the hook didn't run or didn't work)
385 // then go through the normal processing to load a skin
386 if ( $this->skin
=== null ) {
387 if ( !in_array( 'skin', $this->getConfig()->get( 'HiddenPrefs' ) ) ) {
389 $userSkin = $this->getUser()->getOption( 'skin' );
390 $userSkin = $this->getRequest()->getVal( 'useskin', $userSkin );
392 # if we're not allowing users to override, then use the default
393 $userSkin = $this->getConfig()->get( 'DefaultSkin' );
396 // Normalize the key in case the user is passing gibberish
397 // or has old preferences (T71566).
398 $normalized = Skin
::normalizeKey( $userSkin );
400 // Skin::normalizeKey will also validate it, so
401 // this won't throw an exception
402 $this->skin
= $factory->makeSkin( $normalized );
405 // After all that set a context on whatever skin got created
406 $this->skin
->setContext( $this );
413 * Get a Message object with context set
414 * Parameters are the same as wfMessage()
416 * @param string|string[]|MessageSpecifier $key Message key, or array of keys,
417 * or a MessageSpecifier.
418 * @param mixed $args,...
421 public function msg( $key ) {
422 $args = func_get_args();
424 return wfMessage( ...$args )->setContext( $this );
428 * Get the RequestContext object associated with the main request
430 * @return RequestContext
432 public static function getMain() {
433 if ( self
::$instance === null ) {
434 self
::$instance = new self
;
437 return self
::$instance;
441 * Get the RequestContext object associated with the main request
442 * and gives a warning to the log, to find places, where a context maybe is missing.
444 * @param string $func
445 * @return RequestContext
448 public static function getMainAndWarn( $func = __METHOD__
) {
449 wfDebug( $func . ' called without context. ' .
450 "Using RequestContext::getMain() for sanity\n" );
452 return self
::getMain();
456 * Resets singleton returned by getMain(). Should be called only from unit tests.
458 public static function resetMain() {
459 if ( !( defined( 'MW_PHPUNIT_TEST' ) ||
defined( 'MW_PARSER_TEST' ) ) ) {
460 throw new MWException( __METHOD__
. '() should be called only from unit tests!' );
462 self
::$instance = null;
466 * Export the resolved user IP, HTTP headers, user ID, and session ID.
467 * The result will be reasonably sized to allow for serialization.
472 public function exportSession() {
473 $session = MediaWiki\Session\SessionManager
::getGlobalSession();
475 'ip' => $this->getRequest()->getIP(),
476 'headers' => $this->getRequest()->getAllHeaders(),
477 'sessionId' => $session->isPersistent() ?
$session->getId() : '',
478 'userId' => $this->getUser()->getId()
483 * Import an client IP address, HTTP headers, user ID, and session ID
485 * This sets the current session, $wgUser, and $wgRequest from $params.
486 * Once the return value falls out of scope, the old context is restored.
487 * This method should only be called in contexts where there is no session
488 * ID or end user receiving the response (CLI or HTTP job runners). This
489 * is partly enforced, and is done so to avoid leaking cookies if certain
490 * error conditions arise.
492 * This is useful when background scripts inherit context when acting on
493 * behalf of a user. In general the 'sessionId' parameter should be set
494 * to an empty string unless session importing is *truly* needed. This
495 * feature is somewhat deprecated.
497 * @note suhosin.session.encrypt may interfere with this method.
499 * @param array $params Result of RequestContext::exportSession()
500 * @return ScopedCallback
501 * @throws MWException
504 public static function importScopedSession( array $params ) {
505 if ( strlen( $params['sessionId'] ) &&
506 MediaWiki\Session\SessionManager
::getGlobalSession()->isPersistent()
508 // Sanity check to avoid sending random cookies for the wrong users.
509 // This method should only called by CLI scripts or by HTTP job runners.
510 throw new MWException( "Sessions can only be imported when none is active." );
511 } elseif ( !IP
::isValid( $params['ip'] ) ) {
512 throw new MWException( "Invalid client IP address '{$params['ip']}'." );
515 if ( $params['userId'] ) { // logged-in user
516 $user = User
::newFromId( $params['userId'] );
518 if ( !$user->getId() ) {
519 throw new MWException( "No user with ID '{$params['userId']}'." );
521 } else { // anon user
522 $user = User
::newFromName( $params['ip'], false );
525 $importSessionFunc = function ( User
$user, array $params ) {
526 global $wgRequest, $wgUser;
528 $context = RequestContext
::getMain();
530 // Commit and close any current session
531 if ( MediaWiki\Session\PHPSessionHandler
::isEnabled() ) {
532 session_write_close(); // persist
533 session_id( '' ); // detach
534 $_SESSION = []; // clear in-memory array
537 // Get new session, if applicable
539 if ( strlen( $params['sessionId'] ) ) { // don't make a new random ID
540 $manager = MediaWiki\Session\SessionManager
::singleton();
541 $session = $manager->getSessionById( $params['sessionId'], true )
542 ?
: $manager->getEmptySession();
545 // Remove any user IP or agent information, and attach the request
546 // with the new session.
547 $context->setRequest( new FauxRequest( [], false, $session ) );
548 $wgRequest = $context->getRequest(); // b/c
550 // Now that all private information is detached from the user, it should
551 // be safe to load the new user. If errors occur or an exception is thrown
552 // and caught (leaving the main context in a mixed state), there is no risk
553 // of the User object being attached to the wrong IP, headers, or session.
554 $context->setUser( $user );
555 $wgUser = $context->getUser(); // b/c
556 if ( $session && MediaWiki\Session\PHPSessionHandler
::isEnabled() ) {
557 session_id( $session->getId() );
558 Wikimedia\
quietCall( 'session_start' );
560 $request = new FauxRequest( [], false, $session );
561 $request->setIP( $params['ip'] );
562 foreach ( $params['headers'] as $name => $value ) {
563 $request->setHeader( $name, $value );
565 // Set the current context to use the new WebRequest
566 $context->setRequest( $request );
567 $wgRequest = $context->getRequest(); // b/c
570 // Stash the old session and load in the new one
571 $oUser = self
::getMain()->getUser();
572 $oParams = self
::getMain()->exportSession();
573 $oRequest = self
::getMain()->getRequest();
574 $importSessionFunc( $user, $params );
576 // Set callback to save and close the new session and reload the old one
577 return new ScopedCallback(
578 function () use ( $importSessionFunc, $oUser, $oParams, $oRequest ) {
580 $importSessionFunc( $oUser, $oParams );
581 // Restore the exact previous Request object (instead of leaving FauxRequest)
582 RequestContext
::getMain()->setRequest( $oRequest );
583 $wgRequest = RequestContext
::getMain()->getRequest(); // b/c
589 * Create a new extraneous context. The context is filled with information
590 * external to the current session.
591 * - Title is specified by argument
592 * - Request is a FauxRequest, or a FauxRequest can be specified by argument
593 * - User is an anonymous user, for separation IPv4 localhost is used
594 * - Language will be based on the anonymous user and request, may be content
595 * language or a uselang param in the fauxrequest data may change the lang
596 * - Skin will be based on the anonymous user, should be the wiki's default skin
598 * @param Title $title Title to use for the extraneous request
599 * @param WebRequest|array $request A WebRequest or data to use for a FauxRequest
600 * @return RequestContext
602 public static function newExtraneousContext( Title
$title, $request = [] ) {
604 $context->setTitle( $title );
605 if ( $request instanceof WebRequest
) {
606 $context->setRequest( $request );
608 $context->setRequest( new FauxRequest( $request ) );
610 $context->user
= User
::newFromName( '127.0.0.1', false );